Skip to content

feat: add file exporter implementation#5207

Open
herin049 wants to merge 18 commits into
open-telemetry:mainfrom
herin049:feat/file-exporter
Open

feat: add file exporter implementation#5207
herin049 wants to merge 18 commits into
open-telemetry:mainfrom
herin049:feat/file-exporter

Conversation

@herin049
Copy link
Copy Markdown
Contributor

@herin049 herin049 commented May 14, 2026 •
edited
Loading

Description

Adds support for the OTLP JSON File exporter as outlined in OTel spec: https://opentelemetry.io/docs/specs/otel/protocol/file-exporter/

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

uv run tox -e py314-test-opentelemetry-exporter-otlp-json-file

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@herin049 herin049 marked this pull request as ready for review May 16, 2026 04:27
@herin049 herin049 requested a review from a team as a code owner May 16, 2026 04:27
@herin049 herin049 added exporters Approve Public API check This label shows that the public symbols added or changed in a PR are strictly necessary labels May 16, 2026
@xrmx xrmx moved this to Ready for review in Python PR digest May 18, 2026
ocelotl
ocelotl reviewed May 19, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ocelotl ocelotl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lookiing good! Left some comments but in general I am ok ✌️

Comment thread .changelog/5207.added
Comment thread ...opentelemetry-exporter-otlp-json-file/src/opentelemetry/exporter/otlp/json/file/_internal.py
Comment thread exporter/opentelemetry-exporter-otlp-json-file/tests/test_log_exporter.py Outdated
Comment thread ...opentelemetry-exporter-otlp-json-file/src/opentelemetry/exporter/otlp/json/file/_internal.py
@herin049 herin049 requested a review from ocelotl May 20, 2026 03:45
@pmcollins
Copy link
Copy Markdown
Member

pmcollins commented May 20, 2026

Nice addition. I ran this code locally to see the output and got {"resource": {}} JSON lines, whereas the spec examples embed this in a little bit of additional structure: {"resourceSpans": [{"resource": {}}]} {"resourceMetrics": [{"resource": {}}]} {"resourceLogs": [{"resource": {}}]}.

@herin049
Copy link
Copy Markdown
Contributor Author

herin049 commented May 20, 2026

https://opentelemetry.io/docs/specs/otel/protocol/file-exporter/

@pmcollins Good catch, I should be writing a single line for each TracesData object not each ResourceSpans object. Will update the PR shortly.

@herin049
Copy link
Copy Markdown
Contributor Author

herin049 commented May 20, 2026

@pmcollins Updated.

pmcollins
pmcollins reviewed May 21, 2026
View reviewed changes
Comment thread ...elemetry-exporter-otlp-json-file/src/opentelemetry/exporter/otlp/json/file/trace_exporter.py
return
self._shutdown = True
if self._owns_stream:
self._stream.close()
Copy link
Copy Markdown
Member

@pmcollins pmcollins May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a race condition possible here if thread A gets past the check, then thread B sets the flag and closes the stream, then thread A tries to write or flush? Could use composition and a private helper class across the three exporters: e.g. a _FileWriter with a synchronized write_line() and shutdown(). WDYT?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pmcollins pmcollins pmcollins left review comments

+1 more reviewer

@ocelotl ocelotl ocelotl approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

Approve Public API check This label shows that the public symbols added or changed in a PR are strictly necessary exporters

Projects

Python PR digest
Status: Ready for review

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@herin049 @pmcollins @ocelotl @xrmx